package com.task.sql.schedule.config;/**
 * @ClassName : Swagger2Config
 * @Description :
 * @Author : liudonghai
 * @Date: 2024-09-10 14:17
 */

/**
 * @ClassName : Swagger2Config
 * @Description :
 * @Author : liudonghai
 * @Date: 2024-09-10 14:17
 */


import io.swagger.models.Contact;
import lombok.extern.slf4j.Slf4j;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * swagger配置文件
 */
@Slf4j
@Configuration
@EnableSwagger2
public class Swagger2Config {

    @Bean
    public Docket createRestApi() {
        log.info("进入到swagger的配置中,swagger地址：http://<host>:<port>/swagger-ui.html");
        return new Docket(DocumentationType.SWAGGER_2)
                // 指定构建api文档的详细信息的方法：apiInfo()
                .apiInfo(apiInfo())
                .select()
                // 指定要生成api接口的包路径，这里把controller作为包路径，生成controller中的所有接口
                .apis(RequestHandlerSelectors.basePackage("com.task.sql.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    /**
     * 构建api文档的详细信息
     * @return
     */
    private ApiInfo apiInfo() {
        Contact contact = new Contact();
        contact.setUrl("http://localhost:8000/");
        contact.setEmail("15810575172@163.com");
        contact.setName("测试swagger");
        return new ApiInfoBuilder()
                // 设置页面标题
                .title("Spring Boot集成Swagger2接口总览")
                // 设置接口描述
                .description("Swagger接口学习")
                // 设置联系方式
                .contact("15810575172@163.com")
                // 设置版本
                .version("1.0")
                // 构建
                .build();
    }
}
